Documentation Cleanup and Rustdoc Deployment Improvements #2129
Conversation
There was a problem hiding this comment.
While the cross-links and links to benchmarks are useful, this PR doesn't address the corresponding issue:
- This PR doesn't clean up or reorganize documentation.
- It doesn't create a docs.rs following Cairo Native docs as a reference.
- While the aquamarine dependency is added, it is not used.
I think the corresponding issue has to be divided into sub issues so we avoid having a huge PR that attempts to address this. What do you think?
| make hyper-threading-benchmarks | ||
| ``` | ||
|
|
||
| Benchmark results are available in [docs/benchmarks/criterion_benchmark.pdf](docs/benchmarks/criterion_benchmark.pdf) and [docs/benchmarks/flamegraph.svg](docs/benchmarks/flamegraph.svg). |
There was a problem hiding this comment.
Why are you removing most of this section?
| //! # Cairo VM | ||
| //! | ||
| //! This crate provides a fast and safe implementation of the Cairo virtual machine in Rust. | ||
| //! | ||
| //! - [Project README](https://github.com/lambdaclass/cairo-vm/blob/main/README.md) | ||
| //! - [Extended documentation](https://github.com/lambdaclass/cairo-vm/blob/main/docs/README.md) | ||
| //! | ||
| //! ## Features | ||
| //! - STARK-friendly execution trace | ||
| //! - Custom hint processor support | ||
| //! - Tracing and debugging tools |
There was a problem hiding this comment.
While the links are correct, the rest might be a copy (or can be included) in the README.
| //! ## Example | ||
| //! ```rust | ||
| //! use cairo_vm::vm::vm_core::VirtualMachine; | ||
| //! // ... usage example ... | ||
| //! ``` |
There was a problem hiding this comment.
This example doesn't seem to be very useful IMO.
| //! ## Diagrams | ||
| //! Mermaid diagrams are supported in rustdoc via the `aquamarine` dependency. |
There was a problem hiding this comment.
What does this mean? Why is this here?
Yes, i think you're right, maybe it would be really better to divide this issue |
Description
This pull request addresses #2091 Documentation Cleanup by reorganizing and improving the project documentation, enhancing cross-references, and automating the deployment of Rust API documentation.
Key changes include:
These changes make the documentation more discoverable, up-to-date, and easier to maintain, while also ensuring that both benchmarks and API docs are always available online.
Checklist